The Source Control Integration API > The source control integration API optional functions > SCS_GetErrorMessage()

 

SCS_GetErrorMessage()

Description

Returns the last error message. If you implement getErrorMessage(), Dreamweaver calls it each time one of your API functions returns false.

If a routine returns -1 or false, it indicates an error message should be available.

Arguments

connectionData, errorMsg, msgLength

connectionData is a pointer to the agent's data that was passed into Dreamweaver during the Connect() call.
errorMsg is a preallocated string for the DLL to fill in with the error message.
msgLength is the length of the errorMsg buffer passed in.

Returns

true if successful, false if not.